home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / infodoor.zip / INFODOOR.DOC < prev    next >
Text File  |  1991-10-25  |  6KB  |  152 lines
  1.                                                                      1.
  2.  
  3.  
  4.  
  5.  
  6.                                    INFO DOOR
  7.                       (C) Copyright 1991 by Stanley Sheff
  8.                         Support BBS: The Brainex System
  9.                                (310) 275-2344
  10.                                (310) 273-5234
  11.                  -------------------------------------------
  12.  
  13.    Here's a simple door that will do just one thing: Show a text file!
  14.    I'm sure you will find many uses for this door such as:
  15.  
  16.                  Display Instructions for a door.
  17.                  Show your BBS User Manual or Help File
  18.                  Tell a caller a door is down.
  19.  
  20.    This door works with GAP, PCBoard, Wildcat, Spitfire, WWIV, and RBBS,
  21.    as well as any BBS that generates a DOOR.SYS file when running a door.
  22.  
  23.  
  24.    The setup of INFO DOOR is simple, all you need to do is create a
  25.    directory for INFO DOOR and its files then copy the files into that
  26.    directory. After that you will need to create a config file with 
  27.    the following information and place it in that directory.
  28.  
  29.  
  30.  
  31.     
  32.     (sample INFO.CNF)
  33.  
  34.  c:\gapn1
  35.  The Brainex System
  36.  GAP
  37.  
  38.  
  39. ===================================================================
  40. Line 1    Path to DOOR.SYS, DORINFO1.DEF, CHAIN.TXT, or SFDOORS.DAT
  41. Line 2    BBS Name
  42. Line 3    BBS Type: GAP (DOOR.SYS)               SF   (Spitfire/SFDOORS.DAT)
  43.                     WC3 (Wildcat 3/DOOR.SYS)     WWIV (CHAIN.TXT)
  44.                     PCB (PCBOARD 14/DOOR.SYS)    RBBS (DORINFO1.DEF)
  45. ===================================================================
  46.  
  47.    Once you have created your config file, you must then create a a batch 
  48.    file to call the door. A batch file for a GAP BBS might look like this:
  49.    
  50.      ECHO OFF
  51.      CD \DOORS\INFODOOR   
  52.      INFODOOR INFO.CNF /FILE
  53.  
  54. FILE is the actual name of the text file to display.  You can have two
  55. versions, a plain text ASCII and an ANSI COLOR.  Just add a G to the
  56. file name for color: FILEG
  57.  
  58. You do not need to add the G to the batch file command.
  59.  
  60. Here's how you could show a BBS usermanual located in a C:\DOCFILES
  61. directory.  Files in this directory would be MANUAL and MANUALG...
  62.  
  63. INFODOOR INFO.CNF /C:\DOCFILES\MANUAL
  64.  
  65.  
  66.    It is recommended but not required that you call INFODOOR with the
  67.    config file's name on the command line. If you don't, INFODOOR will
  68.    simply default to INFO.CNF.
  69.  
  70.    You will also need to modify your doors menu files and the data
  71.    file that tells the BBS what your doors are and the security
  72.    level needed to access them. For GAP, these are respectively:
  73.    
  74.        DOORM
  75.        DOORMG
  76.        DOORS.DAT
  77.  
  78.    Please refer to your BBS documentation for details on 
  79.    setting up these files.
  80.  
  81.    If you are running multi-nodes, simply create a separate door
  82.    configuration file for each node, and number them. For instance,
  83.    for a 3 node system, you might have the following configuration
  84.    files:
  85.  
  86.        INFO1.CNF
  87.        INFO2.CNF
  88.        INFO3.CNF
  89.  
  90.    The only difference between the three would be the 1st line which
  91.    points to the default directory for the particular node.
  92.  
  93.    Another easy way to add the PAGE to GAP is to use Gap's
  94.    configuration option to create a SYSOP DEFINED COMMAND (consult Gap's 
  95.    docs for info on sysop defined commands). On The Brainex System I use 
  96.    INFO. The batch file to run INFO is named INFO.BAT and placed 
  97.    in the BBS default directory (C:\GAP). When a caller types INFO at the 
  98.    main prompt, they are instantly taken to the INFO door.
  99.  
  100.  
  101.    The following files are read during door initialization. They
  102.    must be present or the door will not operate.
  103.                                 
  104.        DOOR.SYS (or DORINFO1.DEF, CHAIN.TXT, SFDOORS.DAT)
  105.        GAPBBS.CNF  (GAP BBS only)
  106.        USERS       (GAP BBS only)
  107.                                     
  108.    The following sysop functions are available while awaiting
  109.    keyboard input :
  110.  
  111.      F5      - Shell to DOS.
  112.      F8      - Twit user and return to BBS.
  113.     F10      - Initiate chat with user.
  114.     CF10     - Answer user page bell.
  115.     Home     - Main user stats.
  116.     End      - Displays sysop keys available.
  117.     PgDn     - Secondary user stats.
  118.     Up Arrow - Increase user's time remaining by 5 minutes.
  119.     Dn Arrow - Decrease user's time remaining by 5 minutes.
  120.  
  121.    One of the nicer features about using the TWIT key, is the user
  122.    is not told that "the sysop wants them to return to the BBS".
  123.    Instead, a very plain and simple message of "returning you to the
  124.    BBS" is displayed.  This way, the user is given no indication
  125.    that the sysop is hovering about.
  126.  
  127.    When using the F5 shell to DOS key, to return to the door
  128.    program, simply type EXIT at the DOS command prompt. It is not
  129.    necessary to change directories back to the door directory.
  130.    RomBrain is smart enough to know which drive and directory the
  131.    door program is in and will reset the defaults upon return from
  132.    DOS.
  133.  
  134.    The Up and Down Arrow keys increase and decrease the user's time
  135.    respectively by 5 minutes for each press of the key. There is no
  136.    indication of what is occurring (except by the fact the user's
  137.    time remaining will change), so the sysop should try not to have
  138.    a lead finger. The increase or decrease is effective only while
  139.    the user is in RomBrain.
  140.  
  141.  
  142.    This version of INFO DOOR is *FREE*, provided as a courtesy from
  143.    Brainex!
  144.  
  145.  
  146.    Have Fun!
  147.    Stanley Sheff
  148.    The Brainex System
  149.    310-275-2344 HST
  150.    310-273-5234 MNP
  151.  
  152.